schm-sap-outbound-eapi

(0 reviews)

API Reference (Chinese Version)

schm-sap-outbound-eapi

接口描述: 周边调用API 查询业务单据
DEV地址(开发环境): https://schm-api-dev.shiseido.cn/schm-sap-outbound-eapi/api/v1
UAT地址(测试环境): https://schm-api-test.shiseido.cn/schm-sap-outbound-eapi/api/v1
PROD地址(生产环境): https://schm-api.shiseido.cn/schm-sap-outbound-eapi/api/v1

1.身份认证

所有请求头必须包含以下键值参数作为身份验证信息。您需要向管理员申请这些信息。

client_id: fa98****3452
client_secret: 108b****41f2

注意:

生产环境和测试环境的认证方式不同,在生产环境中,需要使用之前注册的账号,登录后,点击对应的应用上线,就会出现生产使用的client_id和client_secret。

2.检查连通性:

可以通过curl命令或者接口工具调用/healthCheck检查接口连通性,成功则返回ok,检查地址如下:

DEV地址(开发环境): https://schm-api-dev.shiseido.cn/schm-sap-outbound-eapi/healthCheck
UAT地址(测试环境): https://schm-api-test.shiseido.cn/schm-sap-outbound-eapi/healthCheck
PROD地址(生产环境): https://schm-api.shiseido.cn/schm-sap-outbound-eapi/healthCheck

3.接口总览:

请求接口描述
/outBound/getBusinessMainSAP下发2B入出库主表查询(新表)
/outBound/getBusinessSubSAP下发2B入出库子表查询(新表)
/outBound/getOrderSAP下发2B入库单(旧表)
/outBound/getRtnSaleSAP下发2B 退货出库(旧表)
/outBound/getNewBusinessSAP下发2B 调整单(旧表)
/outBound/getStockMvmtGRSAP下发 采购单PO回档查询
/outBound/getBusinessSubOMSToC 销售单明细查询(对账用)
/outBound/getBillingDataPoolSAP下发 Billing单据查询
/outBound/getBillingCounteractSAP下发 Billing冲销单据查询
/outBound/getCoupoChargePlatformPOS借贷支付方式查询
/outBound/getOrderConfirmationSAP确认单据查询

完整调用地址为对应环境地址+接口地址,例如:

https://schm-api-test.shiseido.cn/schm-sap-outbound-eapi/api/v1/outBound/getBusinessMain

4.接口调用说明

4.1 SAP下发2B入出库主表查询(新表)

请求接口: /api/v1/outBound/getBusinessMain
接口描述: SAP下发2B入出库主表查询(新表)
请求类型: HTTP GET

4.1.1 请求参数

字段描述字段名称类型长度必填备注
页数据条目pageSizeINT按分页获取数据,每页显示数据条目,不传参数默认为50条
页数pageNoINT按分页获取数据,当前页码。分页从1开始(1为初始页),不传参数默认是第1页
单据编号applyNoVARCHAR1504575834
业务类型businessTypeVARCHAR10
商店代码customerCdVARCHAR10200184
SAP Shipto代码sapCustomerCdVARCHAR2200003451
POS区分customerGroup1VARCHARZ202
SAP的订单编码sapOrderNoVARCHAR4203193399
状态statusVARCHAR3
SAP的订单类型sapApplyTypeVARCHARZ4OR
更新时间updateTimedatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)更新的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss

接口请求示例:
/api/v1/outBound/getBusinessMain?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49

4.1.2 返回参数

字段描述字段名称类型必填备注
返回状态statusString"success" 表示成功,"error"表示失败
当前页码pageNoINT
每页显示数据条目pageSizeINT
总页数totalPagesINT
总条目数totalRecordsINT
数据dataarray查询出的数据
失败信息messageString当status为error时,会返回message错误信息
data
字段描述字段名称类型必填备注
公司代码COMPANYCDchar785
单据编号APPLYNOchar1504575834
申请日期BusinessTypechar32
商店代码CUSTOMERCDchar00100184
SAP Shipto代码SAP_CUSTOMERCDchar2200003152
客户分类SALEPATNcharK1-经销,K2-代销,FS-直营
POS区分CustomerGroup1charZ201 SMILE POS
Z202 PS POS
Z203 E-ORDER
Z204 CS POS
Z205 SCHD
Z206 OTHERS
Z207 OMS
Z208 ONECX
申请日期APPLYYMDdatetime2022-12-12 00:00:00.000
确认日期AdMinYmddatetime2022-12-27 13:40:15.000
出库日期OUTSTCYMDdatetimeNULL
SAP的订单编码SAPORDERNOchar4202451650
SAP的订单类型SAPAPPLYTYPEcharZ4IO
状态STATUSchar1-申请,2-确认,3-出库,4-到货确认
接口标志IFFlgchar0,EAI用
更新时间UPDATETIMEdatetime2023-03-14 17:11:15.337
更新人UPDATEMANcharSAP
创建人CREATEMANChar
创建时间CREATETIMEdatetime

4.1.3 返回值示例

成功:

{
    "status": "success",
        "pageNo": 1,
        "pageSize": 2,
        "totalPages": 1,
        "totalRecords": 2,
    "data": [
        {
            "COMPANYCD": "785",
            "APPLYNO": "RC103001232024703                  ",
            "BusinessType": "10 ",
            "CUSTOMERCD": "10300123  ",
            "SAP_CUSTOMERCD": "2200003606",
            "SALEPATN": "K1",
            "CustomerGroup1": "Z202",
            "APPLYYMD": "2024-07-05T00:00:00",
            "AdMinYmd": "2024-07-21T23:37:14",
            "OUTSTCYMD": "2024-07-22T00:00:00",
            "SAPORDERNO": "4204409917                         ",
            "SAPAPPLYTYPE": "Z4OR",
            "STATUS": "3",
            "IFFlg": "0",
            "UPDATETIME": "2024-07-23T16:00:32.33",
            "UPDATEMAN": "SAP                 ",
            "CREATEMAN": "SAP                 ",
            "CREATETIME": "2024-07-22T12:01:19.647"
        },
        {
            "COMPANYCD": "785",
            "APPLYNO": "RC103001232024703                  ",
            "BusinessType": "12 ",
            "CUSTOMERCD": "10300123  ",
            "SAP_CUSTOMERCD": "2200003606",
            "SALEPATN": "K1",
            "CustomerGroup1": "Z202",
            "APPLYYMD": "2024-07-05T00:00:00",
            "AdMinYmd": "2024-07-21T23:37:14",
            "OUTSTCYMD": "2024-07-22T00:00:00",
            "SAPORDERNO": "4204409917-POD                     ",
            "SAPAPPLYTYPE": "Z4OR",
            "STATUS": "3",
            "IFFlg": "0",
            "UPDATETIME": "2024-07-23T16:00:32.453",
            "UPDATEMAN": "SAP                 ",
            "CREATEMAN": "SAP                 ",
            "CREATETIME": "2024-07-23T16:00:47.413"
        }
    ]
}

失败:

{
    "status": "error",
    "message": ""
}

4.2 SAP下发2B入出库子表查询(新表)

请求接口: /api/v1/outBound/getBusinessSub
接口描述: SAP下发2B入出库子表查询(新表)
请求类型: HTTP GET

4.2.1 请求参数

字段描述字段名称类型长度必填备注
页数据条目pageSizeINT按分页获取数据,每页显示数据条目,不传参数默认为50条
页数pageNoINT按分页获取数据,当前页码。分页从1开始(1为初始页),不传参数默认是第1页
单据编号applyNoVARCHAR1504575834
申请日期applyYmddatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
业务类型businessTypeVARCHAR10
商店代码customerCdVARCHAR10200184
SAP Shipto代码sapCustomerCdVARCHAR2200003451
POS区分customerGroup1VARCHARZ202
SAP的订单编码sapOrderNoVARCHAR4203193399
客户分类salePatnVARCHAR4203193399
状态statusVARCHAR3
SAP的订单类型sapApplyTypeVARCHARZ4OR
出/入库交货单号deliveryNoVARCHAR4402988335
物料确定号determineCodeVARCHAR4402988335
SAP的STO单号applyNoStoVARCHAR4402988335
更新时间updateTimedatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)更新的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss

接口请求示例:
/api/v1/outBound/getBusinessSub?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49

4.2.2 返回参数

字段描述字段名称类型必填备注
返回状态statusString"success" 表示成功,"error"表示失败
当前页码pageNoINT
每页显示数据条目pageSizeINT
总页数totalPagesINT
总条目数totalRecordsINT
数据dataarray查询出的数据
失败信息messageString当status为error时,会返回message错误信息
data
字段描述字段名称类型必填备注
公司代码COMPANYCDchar
单据编号APPLYNOchar"POS/SCHD/E-ORDER 单号OMS Document No."
申请日期APPLYYMDdatetime
业务类型BusinessTypechar"10补货到门店
11退货到公司
20门店销售
21门店退货
30免费销售单
31免费单退货"
订单原因(Head)REASONCDchar"①免费单和退货才有,其他情况不是必输②免费单上传只OMS才有"
订单原因描述ReasonDeschar
POS区分CustomerGroup1char"POS区分
Z201 SMILE POS
Z202 PS POS
Z203 E-ORDER
Z204 CS POS
Z205 SCHD
Z206 OTHERS
Z207 OMS
Z208 ONECX"
售达方SOLDTOCODEchar
商店代码CUSTOMERCDchar周边商店代码
SAP Shipto代码SAP_CUSTOMERCDchar
客户分类SALEPATNchar"K1-经销
K2-代销
FS-直营"
需要交货日期RequestedDatedatetime
促销事件PromotionEventschar
备注(Link POS)headerTXTchar其他文本信息
备注(Link WMS)headerNotechar交货信息,信息可以带到WMS
SAP销售订单号SAPORDERNOchar
SAP订单类型SAPAPPLYTYPEchar
出/入库交货单号DeliveryNOchar
出/入库交货单类型DeliveryTypechar
出/入库日期INOUTSTCYMDdatetime
小程序订单号APP_OrderNocharOMS专用
支付日期PayDatedatetimeOMS专用
汇总单号DailySummaryNocharOMS合单后单号
外部店代码号ExCUSTOMERCDchar
供应商编码SAP_VENDORCODEchar
供应商名称SAP_VENDORNAMEchar
货币CURCYchar
订单行项目POSEXchar
交货单行项目COSNRchar
产品代码PRODUCTCDchar周边8位产品代码
SAP产品代码SAPPRODUCTCDchar
物料确定号DETERMINECODEchar
物料描述DESCRIBEchar
批次CHARGchar
到期日期ExpiryDatedatime
申请数量APPLYRQNTYint
免费品标识Freegoodschar
"Reason for rejection 拒绝原因 (ITEM)"RejectReasonchar
Item Description 行描述ItemDECchar
Plant 工厂Plantchar
库位代码LGORTchar
订单净值NETVALUEmoney不含税行项目总价
承认数量ADMQNTYint
承认年月日AdMinYmddatetime
零售单价RPRICEMNYmoney
零售金额RETAILMNYmoney
批发单价(含税)WPRICEMNYmoney"如果是FSS/OMS 是销售实际销售价格"
批发金额(含税)WHOLEMNYmoney
商品单价(除税)UPRICEMNYmoney
商品金额(除税)UNITMNYmoney
税率TaxPriceint
税额TaxAmountmoney
退货价格ReturnPricemoney
退货金额ReturnAmountmoney
UoM 单位MEINSchar
出入库数量INOUTSTCNumint
销售备注NOTEnvarchar出库单中订单备注
更新时间UPDATETIMEdatetime
更新担当UPDATEMANchar
状态字STATUSchar"1-申请
2-确认
3-出库
4-到货确认"
接口运行标志IFFlgcharEAI用
SAP的STO单号APPLYNO_STOchar
补/退标识SaleRtnflgChar"S:补货/POD多发
R:退仓/POD少发"
创建人CREATEMANChar
创建时间CREATETIMEdatetime
物料类型标识PRODTYPEChar"1:服务性物料
0:非服务性物料"
开票标识BillingFlgChar1:已开票
对账平台传送标识CHECKPLATFLGCharEAI用
用途USECODEChar
决裁案件号DecisionNovarchar
成本中心CostCenterChar
起订量特殊标识SDABWChar当订单原因是 519(实物返库),并且SAP订单类型是Z4OR且库位 W001则起订量标识EAI赋值Z002
销售组织SAP_SALESORGANIZATIONChar
决裁案件番号imw_matter_numbervarchar
品牌BRANDChar合单用
申请人员工编号EMPCODEvarcharFor决裁
申请人姓名EMPNAMEvarcharFor决裁
不启用最小起订量标识SDABWFLGCHAR"1-不启用最小起订量
0或空-启用"
IO号IONumvarchar

4.2.3 返回值示例

成功:

{
    "status": "success",
        "pageNo": 1,
        "pageSize": 2,
        "totalPages": 1,
        "totalRecords": 2,
    "data": [
        {
            "COMPANYCD": "785",
            "APPLYNO": "RC103001232024704                  ",
            "APPLYYMD": "2024-07-05T00:00:00",
            "BusinessType": "10 ",
            "REASONCD": null,
            "ReasonDes": null,
            "CustomerGroup1": "Z202",
            "SOLDTOCODE": "2100002874",
            "CUSTOMERCD": "10300123  ",
            "SAP_CUSTOMERCD": "2200003606",
            "SALEPATN": "K1",
            "RequestedDate": "2024-07-05T00:00:00",
            "PromotionEvents": null,
            "headerTXT": null,
            "headerNote": null,
            "SAPORDERNO": "4204409918                         ",
            "SAPAPPLYTYPE": "Z4OR",
            "DeliveryNO": "4405007820",
            "DeliveryType": "Z4LF",
            "INOUTSTCYMD": "2024-07-22T00:00:00",
            "APP_OrderNo": null,
            "PayDate": null,
            "DailySummaryNo": null,
            "ExCUSTOMERCD": null,
            "SAP_VENDORCODE": null,
            "SAP_VENDORNAME": null,
            "CURCY": "CNY",
            "POSEX": "000011",
            "COSNR": "000010",
            "PRODUCTCD": "78700787  ",
            "SAPPRODUCTCD": "78700787101  ",
            "DETERMINECODE": "78700787101  ",
            "DESCRIBE": null,
            "CHARG": "COMMON    ",
            "ExpiryDate": "2027-07-10T00:00:00",
            "APPLYRQNTY": 1,
            "Freegoods": "0",
            "RejectReason": null,
            "ItemDEC": null,
            "Plant": "7857",
            "LGORT": "W001    ",
            "NETVALUE": 849.56,
            "ADMQNTY": 1,
            "AdMinYmd": "2024-07-21T23:37:19",
            "RPRICEMNY": 1280,
            "RETAILMNY": 1280,
            "WPRICEMNY": 960,
            "WHOLEMNY": 960,
            "UPRICEMNY": 849.56,
            "UNITMNY": 849.56,
            "TaxPrice": 13,
            "TaxAmount": 110.44,
            "ReturnPrice": null,
            "ReturnAmount": null,
            "MEINS": "EA ",
            "INOUTSTCNum": 1,
            "NOTE": null,
            "UPDATETIME": "2024-07-23T16:00:32.233",
            "UPDATEMAN": "SAP                 ",
            "STATUS": "3",
            "IFFlg": "0",
            "APPLYNO_STO": null,
            "SaleRtnflg": "S",
            "CREATEMAN": "SAP                 ",
            "CREATETIME": "2024-07-22T14:00:50.107",
            "PRODTYPE": null,
            "BillingFlg": null,
            "CHECKPLATFLG": null,
            "USECODE": null,
            "DecisionNo": null,
            "CostCenter": null,
            "SDABW": null,
            "SAP_SALESORGANIZATION": null,
            "imw_matter_number": null,
            "BRAND": null,
            "EMPCODE": null,
            "EMPNAME": null,
            "SDABWFLG": null,
            "IONum": null
        },
        {
            "COMPANYCD": "785",
            "APPLYNO": "MV103000782024703                  ",
            "APPLYYMD": "2024-07-19T00:00:00",
            "BusinessType": "10 ",
            "REASONCD": null,
            "ReasonDes": null,
            "CustomerGroup1": "Z202",
            "SOLDTOCODE": "2100002780",
            "CUSTOMERCD": "10300078  ",
            "SAP_CUSTOMERCD": "2200003565",
            "SALEPATN": "K2",
            "RequestedDate": null,
            "PromotionEvents": null,
            "headerTXT": null,
            "headerNote": null,
            "SAPORDERNO": "4101636263                         ",
            "SAPAPPLYTYPE": "Z4KB",
            "DeliveryNO": "4405007817",
            "DeliveryType": "Z4LF",
            "INOUTSTCYMD": "2024-07-22T00:00:00",
            "APP_OrderNo": null,
            "PayDate": null,
            "DailySummaryNo": null,
            "ExCUSTOMERCD": null,
            "SAP_VENDORCODE": null,
            "SAP_VENDORNAME": null,
            "CURCY": null,
            "POSEX": "000011",
            "COSNR": "000010",
            "PRODUCTCD": "78700786  ",
            "SAPPRODUCTCD": "78700786101  ",
            "DETERMINECODE": "78700786101  ",
            "DESCRIBE": null,
            "CHARG": "COMMON    ",
            "ExpiryDate": "2027-07-10T00:00:00",
            "APPLYRQNTY": 3,
            "Freegoods": "0",
            "RejectReason": null,
            "ItemDEC": null,
            "Plant": "7857",
            "LGORT": "W001    ",
            "NETVALUE": null,
            "ADMQNTY": 3,
            "AdMinYmd": "2024-07-22T00:00:00",
            "RPRICEMNY": 1280,
            "RETAILMNY": null,
            "WPRICEMNY": null,
            "WHOLEMNY": null,
            "UPRICEMNY": null,
            "UNITMNY": null,
            "TaxPrice": null,
            "TaxAmount": null,
            "ReturnPrice": null,
            "ReturnAmount": null,
            "MEINS": "EA ",
            "INOUTSTCNum": 3,
            "NOTE": null,
            "UPDATETIME": "2024-07-23T16:00:35.323",
            "UPDATEMAN": "SAP                 ",
            "STATUS": "3",
            "IFFlg": "0",
            "APPLYNO_STO": null,
            "SaleRtnflg": "S",
            "CREATEMAN": "SAP                 ",
            "CREATETIME": "2024-07-22T14:00:50.06",
            "PRODTYPE": null,
            "BillingFlg": null,
            "CHECKPLATFLG": null,
            "USECODE": null,
            "DecisionNo": null,
            "CostCenter": null,
            "SDABW": null,
            "SAP_SALESORGANIZATION": null,
            "imw_matter_number": null,
            "BRAND": null,
            "EMPCODE": null,
            "EMPNAME": null,
            "SDABWFLG": null,
            "IONum": null
        }
    ]
}

失败:

{
    "status": "error",
    "message": ""
}

4.3 SAP下发2B入库单(旧表)

请求接口: /api/v1/outBound/getOrder
接口描述: SAP下发2B入库单(旧表)
请求类型: HTTP GET

4.3.1 请求参数

字段描述字段名称类型长度必填备注
页数据条目pageSizeINT按分页获取数据,每页显示数据条目,不传参数默认为50条
页数pageNoINT按分页获取数据,当前页码。分页从1开始(1为初始页),不传参数默认是第1页
受注编号orderNoVARCHAR1504575834
产品代码productCdVARCHAR
商店代码customerCdVARCHAR
交货单编号shipNoVARCHAR
受注年月日orderYMDdatetime2024-10-08 00:00:00.000,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
出库年月日outStcYMDdatetime2024-10-08 00:00:00.000,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
状态statusVARCHAR3
销售订单号sapOrderNoVARCHAR4205057289
更新时间updateTimedatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)更新的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss

接口请求示例:
/api/v1/outBound/getOrder?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49

4.3.2 返回参数

字段描述字段名称类型必填备注
返回状态statusString"success" 表示成功,"error"表示失败
当前页码pageNoINT
每页显示数据条目pageSizeINT
总页数totalPagesINT
总条目数totalRecordsINT
数据dataarray查询出的数据
失败信息messageString当status为error时,会返回message错误信息
data
字段描述字段名称类型必填备注
受注编号ORDERNOchar
公司代码CompanyCdchar
商店代码CUSTOMERCDchar
产品代码PRODUCTCDchar
红黑字REDBLKNOint
送货地代码DeliverAddCDchar
紧急出库标志StcFlgchar"0-非紧急;
1-紧急"
指定生产日期DirectProductYmddatetime
产品生产日期ProductYmddatetime
场所代码PLACECDchar
销售人员代码SALEMANCDvarchar
交货单编号SHIPNOchar
受注担当ORDDTMANchar
受注年月日ORDERYMDdatetime
受注大包装数量MailinnoBigNumint
受注数量ORDERQNTYint
承认担当ADMDTMANchar
确认大包装数量AdmMailinnoBigNumint
承认数量ADMQNTYint
缺货数量ShortQntyint
缺货金额ShortMnymoney缺货金额=缺货数量*批发单价
订单原因OUTSTCNOchar
出库年月日OUTSTCYMDdatetime
批发金额WHOLEMNYmoney
零售金额RETAILMNYmoney
状态字STATUSchar"0-脱销,
1-受注,
2-出库,
3-出库订正,
5-承认,
7-终止出库,
8-脱销出库,
9-出库完成,
A-入库完成,
B-受入不符,
C-在库确保,
D-伪出库,
E-照合完成(已伪出库),
F-照合完成(未伪出库),
G-受注废止
SAP上线后:1-申请;2-出库;C-在库确保;A-代销店销售"
批发单价WPRICEMNYmoney
更新时间UPDATETIMEdatetime
更新担当UPDATEMANchar
商品单价UPRICEMNYfloat
商品金额UNITMNYmoney
增值税金额RISETAXMNYmoney
消费税金额CONTAXMNYmoney
期望到货日期HopeInYmddatetime
实际到货日期InStcYmddatetime
实际入库数量InStcQntyint
承认年月日AdMinYmddatetime
定曜日OUTSTCDAYchar"1~7对应星期一~星期日,
0-紧急出库"
假出库数量FAKEOUTQNTYint
假出库担当FAKEOUTMANchar
指定出库日期HopeOutYmddatetime
出库担当OUTSTCManchar
出库大包装数量OutMailinnoBigNumint
出库数量OUTSTCNumint
实际到货担当InStcManchar
入库大包装数量InMailinnoBigNumint
部门代码DEPMTCDchar
负责人代码AnswerManCodechar
费用支付区分FreeFlgchar"0-未支付;
1-已支付;"
接口区分IFFlgchar"3-待导入SAP;
0-已导入SAP,或未下发店头;
1-已下发店头;"
零售单价RPRICEMNYmoney
缺货年月日QuehuoYmddatetime
销售订单号SAPORDERNOchar
订单类型SAPAPPLYTYPEcharZ4OR:标准订单
销售备注NOTEnvarchar

4.3.3 返回值示例

成功:

{
    "status": "success",
        "pageNo": 1,
        "pageSize": 2,
        "totalPages": 1,
        "totalRecords": 2,
    "data": [
        {
            "ORDERNO": "20240723                           ",
            "CompanyCd": "785",
            "CUSTOMERCD": "23100001  ",
            "PRODUCTCD": "78704071  ",
            "REDBLKNO": 0,
            "DeliverAddCD": null,
            "StcFlg": null,
            "DirectProductYmd": "2024-07-22T00:00:00",
            "ProductYmd": "2024-07-22T00:00:00",
            "PLACECD": "000",
            "SALEMANCD": "0",
            "SHIPNO": null,
            "ORDDTMAN": "SAP                 ",
            "ORDERYMD": "2024-07-22T00:00:00",
            "MailinnoBigNum": 0,
            "ORDERQNTY": 1,
            "ADMDTMAN": null,
            "AdmMailinnoBigNum": null,
            "ADMQNTY": 1,
            "ShortQnty": null,
            "ShortMny": null,
            "OUTSTCNO": null,
            "OUTSTCYMD": "2024-07-22T00:00:00",
            "WHOLEMNY": 216,
            "RETAILMNY": 400,
            "STATUS": "C",
            "WPRICEMNY": 216,
            "UPDATETIME": "2024-07-23T12:02:49.53",
            "UPDATEMAN": "SAP                 ",
            "UPRICEMNY": 0,
            "UNITMNY": 0,
            "RISETAXMNY": 0,
            "CONTAXMNY": 0,
            "HopeInYmd": "2024-07-22T00:00:00",
            "InStcYmd": "2024-07-22T00:00:00",
            "InStcQnty": 0,
            "AdMinYmd": "2024-07-22T23:04:30",
            "OUTSTCDAY": " ",
            "FAKEOUTQNTY": null,
            "FAKEOUTMAN": null,
            "HopeOutYmd": "2024-07-22T00:00:00",
            "OUTSTCMan": null,
            "OutMailinnoBigNum": null,
            "OUTSTCNum": 0,
            "InStcMan": null,
            "InMailinnoBigNum": null,
            "DEPMTCD": null,
            "AnswerManCode": null,
            "FreeFlg": "1",
            "IFFlg": "0",
            "RPRICEMNY": 400,
            "QuehuoYmd": "2024-07-22T00:00:00",
            "SAPORDERNO": "4204409937                         ",
            "SAPAPPLYTYPE": "Z4OR",
            "NOTE": null
        },
        {
            "ORDERNO": "4204409943                         ",
            "CompanyCd": "9Z2",
            "CUSTOMERCD": "23100001  ",
            "PRODUCTCD": "45631     ",
            "REDBLKNO": 0,
            "DeliverAddCD": null,
            "StcFlg": null,
            "DirectProductYmd": "2024-07-23T01:47:21",
            "ProductYmd": "2024-07-23T01:47:21",
            "PLACECD": "000",
            "SALEMANCD": "0",
            "SHIPNO": null,
            "ORDDTMAN": "SAP                 ",
            "ORDERYMD": "2024-07-23T01:47:21",
            "MailinnoBigNum": 0,
            "ORDERQNTY": 2,
            "ADMDTMAN": null,
            "AdmMailinnoBigNum": null,
            "ADMQNTY": 2,
            "ShortQnty": null,
            "ShortMny": null,
            "OUTSTCNO": null,
            "OUTSTCYMD": "2024-07-23T01:47:21",
            "WHOLEMNY": 278.64,
            "RETAILMNY": 516,
            "STATUS": "C",
            "WPRICEMNY": 139.32,
            "UPDATETIME": "2024-07-23T15:01:39.927",
            "UPDATEMAN": "SAP                 ",
            "UPRICEMNY": 0,
            "UNITMNY": 0,
            "RISETAXMNY": 0,
            "CONTAXMNY": 0,
            "HopeInYmd": "2024-07-23T01:47:21",
            "InStcYmd": "2024-07-23T01:47:21",
            "InStcQnty": 0,
            "AdMinYmd": "2024-07-23T01:47:21",
            "OUTSTCDAY": " ",
            "FAKEOUTQNTY": null,
            "FAKEOUTMAN": null,
            "HopeOutYmd": "2024-07-23T01:47:21",
            "OUTSTCMan": null,
            "OutMailinnoBigNum": null,
            "OUTSTCNum": 0,
            "InStcMan": null,
            "InMailinnoBigNum": null,
            "DEPMTCD": null,
            "AnswerManCode": null,
            "FreeFlg": "1",
            "IFFlg": "0",
            "RPRICEMNY": 258,
            "QuehuoYmd": "2024-07-23T01:47:21",
            "SAPORDERNO": "4204409943                         ",
            "SAPAPPLYTYPE": "Z4OR",
            "NOTE": null
        }
    ]
}

失败:

{
    "status": "error",
    "message": ""
}

4.4 SAP下发2B 退货出库(旧表)

请求接口: /api/v1/outBound/getRtnSale
接口描述: SAP下发2B 退货出库(旧表)
请求类型: HTTP GET

4.4.1 请求参数

字段描述字段名称类型长度必填备注
页数据条目pageSizeINT按分页获取数据,每页显示数据条目,不传参数默认为50条
页数pageNoINT按分页获取数据,当前页码。分页从1开始(1为初始页),不传参数默认是第1页
返品编号rtnSaleNoVARCHAR1504575834
产品代码productCdVARCHAR10
商店代码customerCdVARCHAR10200184
返品年月日rtnSaleYMDdatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
处理年月日handleYMDdatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
SAP的订单编码sapOrderNoVARCHAR4203193399
状态statusVARCHAR3
更新时间updateTimedatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)更新的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss

接口请求示例:
/api/v1/outBound/getRtnSale?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49

4.4.2 返回参数

字段描述字段名称类型必填备注
返回状态statusString"success" 表示成功,"error"表示失败
当前页码pageNoINT
每页显示数据条目pageSizeINT
总页数totalPagesINT
总条目数totalRecordsINT
数据dataarray查询出的数据
失败信息messageString当status为error时,会返回message错误信息
data
字段描述字段名称类型必填备注
返品编号RTNSALENOchar
公司代码CompanyCdchar
商店代码CUSTOMERCDchar
产品代码PRODUCTCDchar
红黑字REDBLKNOint
返品年月日RTNSALEYMDdatetime
场所代码PLACECDchar
产品生产日期ProductYmddatetime
良品数量QULQNTYint
不良品数量NOTQULQNTYint
批发单价WPRICEMNYmoney
零售单价RPRICEMNYmoney
批发金额WHOLEMNYmoney
良品化数量HOMQULQNTYint
商品金额UNITMNYmoney
增值税RISETAXMNYmoney
废弃数量REJECTQNTYint
处理年月日HANDLEYMDdatetime
消费税CONTAXMNYmoney
录入担当INDTMANchar
处理担当HANDDTMANchar
更新时间UPDATETIMEdatetime
更新担当UPDATEMANchar
申请者APPLYMANchar
申请数量APPLYMOUNTInt
返品种类RTNKINDchar
订单原因REJECTEDRESONCDchar
返品数量returnqntyint
确认数量ADMINQNTYint
确认日期ADMINYMDdatetime
确认担当ADMINMANchar
状态字STATUSchar"0-返品终止;
1-申请;
2-确认;
Z-代销店退货 SAP上线后变更"
销售订单号SAPORDERNOchar
订单类型SAPAPPLYTYPEcharZ4RE:标准退货单
销售备注NOTEnvarchar
接口运行状态IFFLGchar"0:已抽取
3:未抽取 "

4.4.3 返回值示例

成功:

{
    "status": "success",
        "pageNo": 1,
        "pageSize": 2,
        "totalPages": 1,
        "totalRecords": 2,
    "data": [
        {
            "RTNSALENO": "23171291                           ",
            "CompanyCd": "785",
            "CUSTOMERCD": "33300004",
            "PRODUCTCD": "16173   ",
            "REDBLKNO": 0,
            "RTNSALEYMD": "2023-03-01T00:00:00",
            "PLACECD": "000",
            "ProductYmd": "2023-03-01T00:00:00",
            "QULQNTY": 0,
            "NOTQULQNTY": 0,
            "WPRICEMNY": 181.04,
            "RPRICEMNY": 248,
            "WHOLEMNY": 350312.4,
            "HOMQULQNTY": 0,
            "UNITMNY": 0,
            "RISETAXMNY": 0,
            "REJECTQNTY": 0,
            "HANDLEYMD": "2023-03-01T00:00:00",
            "CONTAXMNY": 0,
            "INDTMAN": "NULL                ",
            "HANDDTMAN": null,
            "UPDATETIME": "2023-07-05T17:07:23.67",
            "UPDATEMAN": "SAP                 ",
            "APPLYMAN": null,
            "APPLYMOUNT": 1935,
            "RTNKIND": null,
            "REJECTEDRESONCD": "99  ",
            "RETURNQNTY": 1935,
            "ADMINQNTY": 1935,
            "ADMINYMD": "2023-03-01T00:00:00",
            "ADMINMAN": "SAP                 ",
            "STATUS": "2",
            "SAPORDERNO": "4300289445                         ",
            "SAPAPPLYTYPE": "Z4RE",
            "NOTE": null,
            "IFFLG": "0  "
        },
        {
            "RTNSALENO": "4300363400                         ",
            "CompanyCd": "785",
            "CUSTOMERCD": "20600517",
            "PRODUCTCD": "74252779",
            "REDBLKNO": 0,
            "RTNSALEYMD": "2023-11-20T00:00:00",
            "PLACECD": "000",
            "ProductYmd": "2023-11-20T00:00:00",
            "QULQNTY": 0,
            "NOTQULQNTY": 0,
            "WPRICEMNY": 502.2,
            "RPRICEMNY": 930,
            "WHOLEMNY": 5022,
            "HOMQULQNTY": 0,
            "UNITMNY": 0,
            "RISETAXMNY": 0,
            "REJECTQNTY": 0,
            "HANDLEYMD": "2023-11-20T00:00:00",
            "CONTAXMNY": 0,
            "INDTMAN": "NULL                ",
            "HANDDTMAN": null,
            "UPDATETIME": "2023-11-20T16:00:26.913",
            "UPDATEMAN": "SAP                 ",
            "APPLYMAN": null,
            "APPLYMOUNT": 10,
            "RTNKIND": null,
            "REJECTEDRESONCD": "99  ",
            "RETURNQNTY": 10,
            "ADMINQNTY": 10,
            "ADMINYMD": "2023-11-20T00:00:00",
            "ADMINMAN": "SAP                 ",
            "STATUS": "2",
            "SAPORDERNO": "4300363400                         ",
            "SAPAPPLYTYPE": "Z4RE",
            "NOTE": null,
            "IFFLG": "0  "
        }
    ]
}

失败:

{
    "status": "error",
    "message": ""
}

4.5 SAP下发2B 调整单(旧表)

请求接口: /api/v1/outBound/getNewBusiness
接口描述: SAP下发2B 调整单(旧表)
请求类型: HTTP GET

4.5.1 请求参数

字段描述字段名称类型长度必填备注
页数据条目pageSizeINT按分页获取数据,每页显示数据条目,不传参数默认为50条
页数pageNoINT按分页获取数据,当前页码。分页从1开始(1为初始页),不传参数默认是第1页
受注编号orderNoVARCHARRC231000012024A01
商店代码customerCdVARCHAR10200184
产品代码productCdVARCHAR78705518
受注年月日orderYMDdatetime如2024-10-08 00:00:00.000,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
出库年月日outStcYMDdatetime如2024-10-08 00:00:00.000,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
状态statusVARCHAR3
更新时间updateTimedatetime如2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)更新的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
销售订单号sapOrderNoVARCHAR4203193399

接口请求示例:
/api/v1/outBound/getNewBusiness?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49

4.5.2 返回参数

字段描述字段名称类型必填备注
返回状态statusString"success" 表示成功,"error"表示失败
当前页码pageNoINT
每页显示数据条目pageSizeINT
总页数totalPagesINT
总条目数totalRecordsINT
数据dataarray查询出的数据
失败信息messageString当status为error时,会返回message错误信息
data
字段描述字段名称类型必填备注
受注编号ORDERNOchar
公司代码CompanyCdchar
商店代码CUSTOMERCDchar
产品代码PRODUCTCDchar
红黑字REDBLKNOint写入值 0 ,2014-11-19
送货地代码DeliverAddCDchar
紧急出库标志StcFlgchar
指定生产日期DirectProductYmddatetime
产品生产日期ProductYmddatetime
场所代码PLACECDchar
销售人员代码SALEMANCDvarchar
交货单编号SHIPNOchar
受注担当ORDDTMANchar
受注年月日ORDERYMDdatetime
受注大包装数量MailinnoBigNumint
受注数量ORDERQNTYint
承认担当ADMDTMANchar
承认年月日AdMinYmddatetime
缺货年月日QuehuoYmddatetime
确认大包装数量AdmMailinnoBigNumint
承认数量ADMQNTYint
缺货数量ShortQntyint
缺货金额ShortMnymoney
订单原因OUTSTCNOchar原为出库总括表编号--2014-04-29
假出库担当FAKEOUTMANCHAR
假出库数量FAKEOUTQNTYint
指定出库日期HopeOutYmddatetime
出库年月日OUTSTCYMDdatetime
出库担当OUTSTCManchar
出库大包装数量OutMailinnoBigNumint
出库数量OUTSTCNumint
期望到货日期HopeInYmddatetime
实际到货日期InStcYmddatetime
实际到货担当InStcManchar
入库大包装数量InMailinnoBigNumint
实际入库数量InStcQntyint
定曜日OUTSTCDAYchar
部门代码DEPMTCDchar
负责人代码AnswerManCodechar
费用支付区分FreeFlgchar
批发单价WPRICEMNYmoney
批发金额WHOLEMNYmoney
商品单价UPRICEMNYfloat
商品金额UNITMNYmoney
零售金额RETAILMNYmoney
增值税金额RISETAXMNYmoney
消费税金额CONTAXMNYmoney
状态字STATUSchar2-完成状态
接口区分IFFlgchar"0-未生成接口;
1-已生成接口;"
更新时间UPDATETIMEdatetime
更新担当UPDATEMANchar
零售单价RPRICEMNYchar
SAP单据类型SAPAPPLYTYPEcharZ4IO:调整领用免费单
POS区分名称POSKBNCHAR
销售订单号SAPORDERNOchar
销售备注NOTEnvarchar

4.5.3 返回值示例

成功:

{
    "status": "success",
        "pageNo": 1,
        "pageSize": 2,
        "totalPages": 1,
        "totalRecords": 2,
    "data": [
        {
            "ORDERNO": "4202483035       ",
            "COMPANYCD": "785",
            "CUSTOMERCD": "20700001",
            "PRODUCTCD": "13998   ",
            "REDBLKNO": 0,
            "DELIVERADDCD": null,
            "STCFLG": "0",
            "DIRECTPRODUCTYMD": "2023-01-06T00:00:00",
            "PRODUCTYMD": "2023-01-06T00:00:00",
            "PLACECD": "000",
            "SALEMANCD": "000",
            "SHIPNO": "4402991338  ",
            "ORDDTMAN": "9999                ",
            "ORDERYMD": "2023-01-06T05:26:17",
            "MAILINNOBIGNUM": 0,
            "ORDERQNTY": 1,
            "ADMDTMAN": "9999                ",
            "ADMINYMD": "2023-01-06T05:26:17",
            "QUEHUOYMD": "2023-01-06T00:00:00",
            "ADMMAILINNOBIGNUM": 0,
            "ADMQNTY": 1,
            "SHORTQNTY": 0,
            "SHORTMNY": 0,
            "OUTSTCNO": "561          ",
            "FAKEOUTMAN": null,
            "FAKEOUTQNTY": 0,
            "HOPEOUTYMD": "2023-01-06T00:00:00",
            "OUTSTCYMD": "2023-01-06T00:00:00",
            "OUTSTCMAN": null,
            "OUTMAILINNOBIGNUM": 0,
            "OUTSTCNUM": 1,
            "HOPEINYMD": "2023-01-06T00:00:00",
            "INSTCYMD": "2023-01-06T00:00:00",
            "INSTCMAN": null,
            "INMAILINNOBIGNUM": 0,
            "INSTCQNTY": 1,
            "OUTSTCDAY": " ",
            "DEPMTCD": null,
            "ANSWERMANCODE": null,
            "FREEFLG": "1",
            "WPRICEMNY": 0,
            "WHOLEMNY": 0,
            "UPRICEMNY": 0,
            "UNITMNY": 0,
            "RETAILMNY": 0,
            "RISETAXMNY": 0,
            "CONTAXMNY": 0,
            "STATUS": "2",
            "IFFLG": "0",
            "UPDATETIME": "2023-07-05T17:01:41.117",
            "UPDATEMAN": "SAP                 ",
            "RPRICEMNY": null,
            "SAPAPPLYTYPE": "Z4IO",
            "POSKBN": "Z499                ",
            "SAPORDERNO": "4202483035                         ",
            "NOTE": null
        },
        {
            "ORDERNO": "4202483035       ",
            "COMPANYCD": "785",
            "CUSTOMERCD": "20700001",
            "PRODUCTCD": "15282   ",
            "REDBLKNO": 0,
            "DELIVERADDCD": null,
            "STCFLG": "0",
            "DIRECTPRODUCTYMD": "2023-01-06T00:00:00",
            "PRODUCTYMD": "2023-01-06T00:00:00",
            "PLACECD": "000",
            "SALEMANCD": "000",
            "SHIPNO": "4402991338  ",
            "ORDDTMAN": "9999                ",
            "ORDERYMD": "2023-01-06T05:26:17",
            "MAILINNOBIGNUM": 0,
            "ORDERQNTY": 8,
            "ADMDTMAN": "9999                ",
            "ADMINYMD": "2023-01-06T05:26:17",
            "QUEHUOYMD": "2023-01-06T00:00:00",
            "ADMMAILINNOBIGNUM": 0,
            "ADMQNTY": 8,
            "SHORTQNTY": 0,
            "SHORTMNY": 0,
            "OUTSTCNO": "561          ",
            "FAKEOUTMAN": null,
            "FAKEOUTQNTY": 0,
            "HOPEOUTYMD": "2023-01-06T00:00:00",
            "OUTSTCYMD": "2023-01-06T00:00:00",
            "OUTSTCMAN": null,
            "OUTMAILINNOBIGNUM": 0,
            "OUTSTCNUM": 8,
            "HOPEINYMD": "2023-01-06T00:00:00",
            "INSTCYMD": "2023-01-06T00:00:00",
            "INSTCMAN": null,
            "INMAILINNOBIGNUM": 0,
            "INSTCQNTY": 8,
            "OUTSTCDAY": " ",
            "DEPMTCD": null,
            "ANSWERMANCODE": null,
            "FREEFLG": "1",
            "WPRICEMNY": 0,
            "WHOLEMNY": 0,
            "UPRICEMNY": 0,
            "UNITMNY": 0,
            "RETAILMNY": 0,
            "RISETAXMNY": 0,
            "CONTAXMNY": 0,
            "STATUS": "2",
            "IFFLG": "0",
            "UPDATETIME": "2023-07-05T17:01:41.117",
            "UPDATEMAN": "SAP                 ",
            "RPRICEMNY": null,
            "SAPAPPLYTYPE": "Z4IO",
            "POSKBN": "Z499                ",
            "SAPORDERNO": "4202483035                         ",
            "NOTE": null
        }
    ]
}

失败:

{
    "status": "error",
    "message": ""
}

4.6 SAP下发 采购单PO回档查询

请求接口: /api/v1/outBound/getStockMvmtGR
接口描述: SAP下发 采购单PO回档查询
请求类型: HTTP GET

4.6.1 请求参数

字段描述字段名称类型长度必填备注
页数据条目pageSizeINT按分页获取数据,每页显示数据条目,不传参数默认为50条
页数pageNoINT按分页获取数据,当前页码。分页从1开始(1为初始页),不传参数默认是第1页
采购订单号poNoVARCHARRC231000012024A01
时间戳(当前时间)Timestampdatetime如2024-10-08 00:00:00.000,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss

接口请求示例:
/api/v1/outBound/getStockMvmtGR?pageNo=1&pageSize=2&Timestamp=2023-06-23 12:02:49

4.6.2 返回参数

字段描述字段名称类型必填备注
返回状态statusString"success" 表示成功,"error"表示失败
当前页码pageNoINT
每页显示数据条目pageSizeINT
总页数totalPagesINT
总条目数totalRecordsINT
数据dataarray查询出的数据
失败信息messageString当status为error时,会返回message错误信息
data
字段描述字段名称类型必填备注
单据唯一标识DocumentIDVARCHAR
凭证日期DocDateVARCHAR
过账日期PostingDateVARCHAR
创建日期CreateDateVARCHAR
创建时间CreateTimeVARCHAR
抬头文本BKTXTVARCHAR
物料凭证ProDocVARCHAR
凭证年度ProDocYearVARCHAR
行项目LinenoVARCHAR
供应商代码VendorCodeVARCHAR
采购订单号PONoVARCHAR
采购单行项目POItemnoVARCHAR
Intramart PONPSPONoVARCHAR
物料代码SAPPRODUCTCDVARCHAR
数量Qntyint
单位ERFMEVARCHAR
工厂PlantVARCHAR
库存地点LGORTVARCHAR
Batch 批次CHARGVARCHAR
移动类型MoveTypeVARCHAR
时间戳(当前时间)Timestampdatetime

4.6.3 返回值示例

成功:

{
    "status": "success",
        "pageNo": 1,
        "pageSize": 2,
        "totalPages": 1,
        "totalRecords": 2,
    "data": [
        {
            "DocumentID": "ed60b9ea58dd475c97f90bc4429f6bd5",
            "DocDate": "20240105",
            "PostingDate": "20240105",
            "CreateDate": "20240104",
            "CreateTime": "220008",
            "BKTXT": "PO2311207",
            "ProDoc": "5003780718",
            "ProDocYear": "2024",
            "Lineno": "0001",
            "VendorCode": "2100003079",
            "PONo": "4560010994",
            "POItemno": "00010",
            "NPSPONo": "PO2311207",
            "SAPPRODUCTCD": "78702537101",
            "Qnty": 10000,
            "ERFME": "EA",
            "Plant": "785B",
            "LGORT": "W001",
            "CHARG": null,
            "MoveType": "101",
            "Timestamp": "2024-10-10T19:50:14"
        },
        {
            "DocumentID": "5a3018b4e036405b8e257d78f656fe3f",
            "DocDate": "20240105",
            "PostingDate": "20240105",
            "CreateDate": "20240104",
            "CreateTime": "220008",
            "BKTXT": "PO2311207",
            "ProDoc": "5003780718",
            "ProDocYear": "2024",
            "Lineno": "0001",
            "VendorCode": "2100003079",
            "PONo": "4560010994",
            "POItemno": "00010",
            "NPSPONo": "PO2311207",
            "SAPPRODUCTCD": "78702537101",
            "Qnty": 10000,
            "ERFME": "EA",
            "Plant": "785B",
            "LGORT": "W001",
            "CHARG": null,
            "MoveType": "101",
            "Timestamp": "2024-10-15T15:14:56"
        }
    ]
}

失败:

{
    "status": "error",
    "message": ""
}

4.7 ToC 销售单明细查询(对账用)

请求接口: /api/v1/outBound/getBusinessSubOMS
接口描述: ToC 销售单明细查询(对账用)
请求类型: HTTP GET

4.7.1 请求参数

字段描述字段名称类型长度必填备注
页数据条目pageSizeINT按分页获取数据,每页显示数据条目,不传参数默认为50条
页数pageNoINT按分页获取数据,当前页码。分页从1开始(1为初始页),不传参数默认是第1页
总数返回标识totalFlgBoolean控制是否返回totalPages、totalRecords参数,boolean类型,true,false,默认为false不返回。
单据编号applyNoVARCHARRC231000012024A01
SAP销售订单号sapOrderNoVARCHAR
汇总单号dailySummaryNoVARCHAR
合单标识summaryFlgVARCHAR该字段由EAI刷新
0-未合单
1-已合单
更新时间updateTimedatetime如2024-10-08 00:00:00.000,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss

接口请求示例:
/api/v1/outBound/getBusinessSubOMS?pageNo=1&pageSize=2&updateTime=2023-06-23 12:02:49&totalFlg=true

4.7.2 返回参数

字段描述字段名称类型必填备注
返回状态statusString"success" 表示成功,"error"表示失败
当前页码pageNoINT
每页显示数据条目pageSizeINT
总页数totalPagesINT根据totalFlg标识返回,为true则返回
总条目数totalRecordsINT根据totalFlg标识返回,为true则返回
数据dataarray查询出的数据
失败信息messageString当status为error时,会返回message错误信息
data
字段描述字段名称类型必填备注
公司代码COMPANYCDchar
单据编号APPLYNOchar"POS 单号
OMS 出库单号"
申请日期APPLYYMDdatetime
业务类型BusinessTypechar"10补货到门店
11退货到公司
20门店销售
21门店退货
30免费销售单
31免费单退货"
订单原因(Head)REASONCDchar"①免费单和退货才有,其他情况不是必输
②免费单上传只OMS才有"
订单原因描述ReasonDeschar
POS区分CustomerGroup1char"Z201 SMILE POS
Z202 PS POS
Z203 E-ORDER
Z204 CS POS
Z205 SCHD
Z206 Others
Z207 OMS
Z208 ONECX"
售达方SOLDTOCODEchar
商店代码CUSTOMERCDchar周边商店代码
SAP Shipto代码SAP_CUSTOMERCDchar
客户分类SALEPATNchar"K1-经销
K2-代销
FS-直营"
需要交货日期RequestedDatedatetime
促销事件PromotionEventschar
备注(Link POS)headerTXTchar其他文本信息
备注(Link WMS)headerNotechar交货信息,信息可以带到WMS
SAP销售订单号SAPORDERNOchar
SAP订单类型SAPAPPLYTYPEchar
出/入库交货单号DeliveryNOchar
出/入库交货单类型DeliveryTypechar
出/入库日期INOUTSTCYMDdatetime
小程序订单号APP_OrderNocharOMS专用
支付日期PayDatedatetimeOMS专用
汇总单号DailySummaryNocharOMS合单后单号
外部店代码号ExCUSTOMERCDchar
供应商编码SAP_VENDORCODEchar
供应商名称SAP_VENDORNAMEchar
货币CURCYchar
订单行项目POSEXchar
交货单行项目COSNRchar
产品代码PRODUCTCDchar周边8位产品代码
SAP产品代码SAPPRODUCTCDchar
物料确定号DETERMINECODEchar
物料描述DESCRIBEchar
批次CHARGchar
到期日期ExpiryDatedatime
申请数量APPLYRQNTYint
免费品标识Freegoodschar
"Reason for rejection 拒绝原因 (ITEM)"RejectReasonchar
Item Description 行描述ItemDECchar
Plant 工厂PLANTchar
库位代码LGORTchar
订单净值NETVALUEmoney不含税行项目总价
承认数量ADMQNTYint
承认年月日AdMinYmddatetime
零售单价RPRICEMNYmoney
零售金额RETAILMNYmoney
批发单价(含税)WPRICEMNYmoney"如果是FSS/OMS
是销售实际销售价格"
批发金额(含税)WHOLEMNYmoney
商品单价(除税)UPRICEMNYmoney
商品金额(除税)UNITMNYmoney
税率TaxPriceint
税额TaxAmountmoney
退货价格ReturnPricemoney
退货金额ReturnAmountmoney
UoM 单位MEINSchar
出入库数量INOUTSTCNumint
销售备注NOTEnvarchar出库单中订单备注
更新时间UPDATETIMEdatetime
更新担当UPDATEMANchar
状态字STATUSchar"1-申请
2-确认
3-出库
4-到货确认"
接口运行标志IFFlgchar"0-已导入SAP,或未下发店头
1-已下发店头
3-待导入SAP"
SAP的STO单号APPLYNO_STOchar
补/退标识SaleRtnFlgChar"S:补货/POD多发
R:退仓/POD少发"
创建人CREATEMANChar
创建时间CREATETIMEdatetime
物料类型标识PRODTYPEChar"1:服务性物料
0:非服务性物料"
开票标识BillingFlgChar1:已开票
对账平台传送标识CheckPlatFlgCharEAI用
用途USECODEChar
决裁案件号DecisionNovarchar
成本中心CostCenterChar
起订量特殊标识SDABWChar起订量标识EAI赋值Z002
销售组织SAP_SALESORGANIZATIONChar
决裁案件番号imw_matter_numbervarchar
品牌BRANDChar
实际分配配额数量ActualQNTYINT
配额不足起订量标识QuotaDeficitFlgchar
申请员工工号EMPCODEVARCHAR
申请员工姓名EMPNAMEVARCHAR
启用起订量标识SDABWFLGCHAR"1-不启用最小起订量
0或空-启用"
单据唯一标识DocumentIDVARCHAR
时间戳(当前时间)Timestampdatetime
周边标识SysFlgCHAR"1-POS
2-SCHD
3-E-order
4-Shopex
5-UCO
6-LeQee
7-决裁
8-采购"
积分兑换标识PointsFlgCHAR1-积分兑换
合单标识SummaryFlgCHAR"该字段由EAI刷新
0-未合单
1-已合单"
订单来源orderSourceVARCHARPOS
品牌编码brandCodeVARCHAR"品牌编码,仅接收如下编码:
CPB、EFM、IPSA、NARS、TG、SDK、SHI、PCV、LM、BAUM"
销售平台channelCodeVARCHARPOS传 pos(小写)
订单类型orderTypeINT"0:销售单
1:退货单"
订单状态orderStatusVARCHAR1:订单完成
支付方式payTypeVARCHARpos(指银行pos)
支付状态payStatusINT"2:已付款
3:已退款"
出入库状态shippedStatusINT"2:已出库
5:已入库"
会员识别号memberIdVARCHAR
店铺名称shopNameVARCHAR不传
源平台单号parentPayCodeVARCHAR有退货时,对应的原单单号
订单生成时间orderTimeVARCHAR
订单生成时间payTimeVARCHAR
应付金额amountVARCHAR本次订单支付金额
修正金额reviseAmountVARCHAR不传
物料编码prdCodeVARCHAR
产品名称prdNameVARCHAR
发货时间shippedTimeVARCHAR
预售标志PresaleFlagVARCHAR0:普通销售、1:预售、2:预售提货、3:团购券购买、4:团购券提货
预售交易单号PresaleTradeNoVARCHAR
BC代码BCCodevarchar

4.7.3 返回值示例

成功:

{
    "status": "success",
        "pageNo": 1,
        "pageSize": 2,
        "totalPages": 1,
        "totalRecords": 2,
    "data": [
        {
            "COMPANYCD": "785",
            "APPLYNO": "1909397583                         ",
            "APPLYYMD": "2024-05-21T00:00:00",
            "BusinessType": "20 ",
            "REASONCD": null,
            "ReasonDes": null,
            "CustomerGroup1": "Z207",
            "SOLDTOCODE": "2100002961",
            "CUSTOMERCD": "10400000  ",
            "SAP_CUSTOMERCD": "2200003134",
            "SALEPATN": "FS",
            "RequestedDate": null,
            "PromotionEvents": null,
            "headerTXT": null,
            "headerNote": null,
            "SAPORDERNO": "                                   ",
            "SAPAPPLYTYPE": "Z4BV",
            "DeliveryNO": null,
            "DeliveryType": null,
            "INOUTSTCYMD": null,
            "APP_OrderNo": "3897472826800671542                ",
            "PayDate": "2024-05-20T00:00:00",
            "DailySummaryNo": "S220000313420241025133128101       ",
            "ExCUSTOMERCD": null,
            "SAP_VENDORCODE": null,
            "SAP_VENDORNAME": null,
            "CURCY": null,
            "POSEX": "10    ",
            "COSNR": null,
            "PRODUCTCD": "16182     ",
            "SAPPRODUCTCD": "10116182205CN",
            "DETERMINECODE": "10116182205CN",
            "DESCRIBE": null,
            "CHARG": "COMMON    ",
            "ExpiryDate": null,
            "APPLYRQNTY": 2,
            "Freegoods": "0",
            "RejectReason": null,
            "ItemDEC": null,
            "PLANT": "785B",
            "LGORT": "W001    ",
            "NETVALUE": null,
            "ADMQNTY": null,
            "AdMinYmd": null,
            "RPRICEMNY": null,
            "RETAILMNY": null,
            "WPRICEMNY": null,
            "WHOLEMNY": 897.1,
            "UPRICEMNY": null,
            "UNITMNY": null,
            "TaxPrice": null,
            "TaxAmount": null,
            "ReturnPrice": null,
            "ReturnAmount": null,
            "MEINS": null,
            "INOUTSTCNum": null,
            "NOTE": null,
            "UPDATETIME": "2024-10-25T13:31:30.417",
            "UPDATEMAN": "EAI                 ",
            "STATUS": "1",
            "IFFlg": "0",
            "APPLYNO_STO": null,
            "SaleRtnFlg": null,
            "CREATEMAN": "EAI                 ",
            "CREATETIME": "2024-10-22T17:40:11.883",
            "PRODTYPE": "0",
            "BillingFlg": null,
            "CheckPlatFlg": "3",
            "USECODE": null,
            "DecisionNo": null,
            "CostCenter": null,
            "SDABW": null,
            "SAP_SALESORGANIZATION": "7851",
            "imw_matter_number": null,
            "BRAND": "11",
            "ActualQNTY": null,
            "QuotaDeficitFlg": "0",
            "EMPCODE": null,
            "EMPNAME": null,
            "SDABWFLG": null,
            "DocumentID": "25092e0a11184690ac2454cdcc67c780",
            "Timestamp": "2024-10-21T15:28:11",
            "SysFlg": "5",
            "PointsFlg": null,
            "SummaryFlg": "1",
            "brandCode": null,
            "channelCode": null,
            "orderType": null,
            "orderStatus": null,
            "payType": null,
            "payStatus": null,
            "shippedStatus": null,
            "memberId": null,
            "shopName": null,
            "parentPayCode": null,
            "orderTime": null,
            "payTime": null,
            "amount": null,
            "reviseAmount": null,
            "prdCode": null,
            "prdName": null,
            "shippedTime": null
        },
        {
            "COMPANYCD": "785",
            "APPLYNO": "1909397583                         ",
            "APPLYYMD": "2024-05-21T00:00:00",
            "BusinessType": "20 ",
            "REASONCD": null,
            "ReasonDes": null,
            "CustomerGroup1": "Z207",
            "SOLDTOCODE": "2100002961",
            "CUSTOMERCD": "10400000  ",
            "SAP_CUSTOMERCD": "2200003134",
            "SALEPATN": "FS",
            "RequestedDate": null,
            "PromotionEvents": null,
            "headerTXT": null,
            "headerNote": null,
            "SAPORDERNO": "                                   ",
            "SAPAPPLYTYPE": "Z4BV",
            "DeliveryNO": null,
            "DeliveryType": null,
            "INOUTSTCYMD": null,
            "APP_OrderNo": "3897472826800671542                ",
            "PayDate": "2024-05-20T00:00:00",
            "DailySummaryNo": "S220000313420241025133128101       ",
            "ExCUSTOMERCD": null,
            "SAP_VENDORCODE": null,
            "SAP_VENDORNAME": null,
            "CURCY": null,
            "POSEX": "20    ",
            "COSNR": null,
            "PRODUCTCD": "16182     ",
            "SAPPRODUCTCD": "10116182205CN",
            "DETERMINECODE": "10116182205CN",
            "DESCRIBE": null,
            "CHARG": "COMMON    ",
            "ExpiryDate": null,
            "APPLYRQNTY": 1,
            "Freegoods": "1",
            "RejectReason": null,
            "ItemDEC": null,
            "PLANT": "785B",
            "LGORT": "W001    ",
            "NETVALUE": null,
            "ADMQNTY": null,
            "AdMinYmd": null,
            "RPRICEMNY": null,
            "RETAILMNY": null,
            "WPRICEMNY": null,
            "WHOLEMNY": 0,
            "UPRICEMNY": null,
            "UNITMNY": null,
            "TaxPrice": null,
            "TaxAmount": null,
            "ReturnPrice": null,
            "ReturnAmount": null,
            "MEINS": null,
            "INOUTSTCNum": null,
            "NOTE": null,
            "UPDATETIME": "2024-10-25T13:31:30.417",
            "UPDATEMAN": "EAI                 ",
            "STATUS": "1",
            "IFFlg": "0",
            "APPLYNO_STO": null,
            "SaleRtnFlg": null,
            "CREATEMAN": "EAI                 ",
            "CREATETIME": "2024-10-22T17:40:11.92",
            "PRODTYPE": "0",
            "BillingFlg": null,
            "CheckPlatFlg": "3",
            "USECODE": null,
            "DecisionNo": null,
            "CostCenter": null,
            "SDABW": null,
            "SAP_SALESORGANIZATION": "7851",
            "imw_matter_number": null,
            "BRAND": "11",
            "ActualQNTY": null,
            "QuotaDeficitFlg": "0",
            "EMPCODE": null,
            "EMPNAME": null,
            "SDABWFLG": null,
            "DocumentID": "25092e0a11184690ac2454cdcc67c780",
            "Timestamp": "2024-10-21T15:28:11",
            "SysFlg": "5",
            "PointsFlg": null,
            "SummaryFlg": "1",
            "brandCode": null,
            "channelCode": null,
            "orderType": null,
            "orderStatus": null,
            "payType": null,
            "payStatus": null,
            "shippedStatus": null,
            "memberId": null,
            "shopName": null,
            "parentPayCode": null,
            "orderTime": null,
            "payTime": null,
            "amount": null,
            "reviseAmount": null,
            "prdCode": null,
            "prdName": null,
            "shippedTime": null
        }
    ]
}

失败:

{
    "status": "error",
    "message": ""
}

4.8 SAP下发 Billing单据查询

请求接口: /api/v1/outBound/getBillingDataPool
接口描述: SAP下发 Billing单据查询
请求类型: HTTP GET

4.8.1 请求参数

字段描述字段名称类型长度必填备注
页数据条目pageSizeINT按分页获取数据,每页显示数据条目,不传参数默认为50条
页数pageNoINT按分页获取数据,当前页码。分页从1开始(1为初始页),不传参数默认是第1页
Billing DocumentbillingNoVARCHAR1504575834
Billing DatebillingYMDdatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
SalesOrder-- SO单号sapOrderNOVARCHAR4300439027
交货单号deliveryNOVARCHAR2200003451
PO日期applyYMDdatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
PO单号applyNOVARCHARRT102002152024140
冲销对应的原单originBillingNOVARCHAR
冲销标识counteractFlgVARCHAR0
更新时间updateTimedatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)更新的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss

接口请求示例:
/api/v1/outBound/getBillingDataPool?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49

4.8.2 返回参数

字段描述字段名称类型必填备注
返回状态statusString"success" 表示成功,"error"表示失败
当前页码pageNoINT
每页显示数据条目pageSizeINT
总页数totalPagesINT
总条目数totalRecordsINT
数据dataarray查询出的数据
失败信息messageString当status为error时,会返回message错误信息
data
字段描述字段名称类型必填备注
Billing DocumentBillingNoCHAR
Billing TypeBillingTypeCHAR
销售组织SAP_SALESORGANIZATIONCHAR
分销渠道SAP_DISTRIBUTIONCHANNELCHAR
Billing DateBillingYMDDATETIME
SAP地区代码SAP_REGIONCHAR
公司代码COMPANYCDCHAR
付款方代码SAP_PayerCDCHAR
Sold-ToSAP_SoldToCDCHAR
付款方名称SAP_PayerNMCHAR
城市CITYCHAR
语言SAP_LANGUAGECHAR
付款方地址1LOCATION1CHAR
付款方地址2LOCATION2CHAR
联络号码ContactNumberCHAR
货币SAP_CURRENCYCHAR
行号POSEXCHAR
开票数量BilledQuantityINT
销售单位SalesunitCHAR
净重Netweightnvarchar
物料代码SAPPRODUCTCDCHAR
物料描述ItemDescriptionCHAR
工厂PLANTCHAR
国家CountryCHAR
净值NetValuemoney
税额TaxAmountmoney
产品条形码PRODBARCODE1CHAR
税号TaxCodeCHAR
税率TaxRatemoney
SalesOrder-- SO单号SAPORDERNOCHAR
SO行号POSEX_SOCHAR
交货单号DeliveryNOCHAR
交货单行号COSNRCHAR
会计凭证号AccountingNOCHAR
PO日期APPLYYMDDATETIME
PO单号APPLYNOCHAR
物料确定号MaterialenteredCHAR
含税总金额WHOLEMNYMONEY
Ship-toSAPCUSTOMERCDCHAR
冲销对应的原单OriginBillingNOCHAR
更新担当UPDATEMANchar
更新时间UPDATETIMEdatetime
创建担当CREATEMANchar
创建担当CREATETIMEdatetime
接口运行标志IFFlgchar
冲销标识counteractFlgchar
产品短码PRODUCTCDchar
销售统计标识SSSFLGchar
对账平台标识CheckPlatFlgchar

4.8.3 返回值示例

成功:

{
    "status": "success",
        "pageNo": 1,
        "pageSize": 2,
        "totalPages": 1,
        "totalRecords": 2,
    "data": [
        {
            "BillingNo": "4700282757",
            "BillingType": "Z4G2",
            "SAP_SALESORGANIZATION": "7851",
            "SAP_DISTRIBUTIONCHANNEL": "14",
            "BillingYMD": "2023-01-31T00:00:00",
            "SAP_REGION": "020",
            "COMPANYCD": "785 ",
            "SAP_PayerCD": "2300001557",
            "SAP_SoldToCD": "2100002963",
            "SAP_PayerNM": "TG_EC_微店                                                                      ",
            "CITY": "上海                                              ",
            "SAP_LANGUAGE": "ZH",
            "LOCATION1": null,
            "LOCATION2": null,
            "ContactNumber": null,
            "SAP_CURRENCY": null,
            "POSEX": "000010",
            "BilledQuantity": 1,
            "Salesunit": "EA ",
            "Netweight": null,
            "SAPPRODUCTCD": "300000300         ",
            "ItemDescription": "THE GINZA-商场白条                                                              ",
            "PLANT": "7857",
            "Country": null,
            "NetValue": 37080.52,
            "TaxAmount": 4820.47,
            "PRODBARCODE1": null,
            "TaxCode": "X1",
            "TaxRate": null,
            "SAPORDERNO": "4300278902",
            "POSEX_SO": "000010",
            "DeliveryNO": "4300278902",
            "COSNR": "000010",
            "AccountingNO": "4700282757",
            "APPLYYMD": null,
            "APPLYNO": null,
            "Materialentered": "300000300                               ",
            "WHOLEMNY": 41900.99,
            "SAPCUSTOMERCD": "2200003131       ",
            "OriginBillingNO": null,
            "UPDATEMAN": "UPDATEMAN           ",
            "UPDATETIME": "2023-07-05T11:24:52.703",
            "CREATEMAN": "SAP                 ",
            "CREATETIME": "2023-05-01T14:00:11.31",
            "IFFlg": "0",
            "counteractFlg": "1",
            "PRODUCTCD": "300000300 ",
            "SSSFLG": "0",
            "CheckPlatFlg": "0"
        },
        {
            "BillingNo": "4700282757",
            "BillingType": "Z4G2",
            "SAP_SALESORGANIZATION": "7851",
            "SAP_DISTRIBUTIONCHANNEL": "14",
            "BillingYMD": "2023-01-31T00:00:00",
            "SAP_REGION": null,
            "COMPANYCD": "785 ",
            "SAP_PayerCD": "2300001557",
            "SAP_SoldToCD": "2100002963",
            "SAP_PayerNM": null,
            "CITY": null,
            "SAP_LANGUAGE": null,
            "LOCATION1": null,
            "LOCATION2": null,
            "ContactNumber": null,
            "SAP_CURRENCY": "CNY  ",
            "POSEX": "10    ",
            "BilledQuantity": 1,
            "Salesunit": "EA ",
            "Netweight": null,
            "SAPPRODUCTCD": "300000300         ",
            "ItemDescription": "THE GINZA-商场白条                                                              ",
            "PLANT": null,
            "Country": null,
            "NetValue": 37080.52,
            "TaxAmount": 4820.47,
            "PRODBARCODE1": null,
            "TaxCode": null,
            "TaxRate": null,
            "SAPORDERNO": "4300278902",
            "POSEX_SO": "10    ",
            "DeliveryNO": "4300278902",
            "COSNR": null,
            "AccountingNO": null,
            "APPLYYMD": null,
            "APPLYNO": null,
            "Materialentered": "300000300                               ",
            "WHOLEMNY": 41900.99,
            "SAPCUSTOMERCD": "2200003131       ",
            "OriginBillingNO": null,
            "UPDATEMAN": "UPDATEMAN           ",
            "UPDATETIME": "2023-07-05T11:24:52.703",
            "CREATEMAN": "EAI                 ",
            "CREATETIME": "2023-04-07T10:53:05",
            "IFFlg": "0",
            "counteractFlg": "1",
            "PRODUCTCD": "300000300 ",
            "SSSFLG": "0",
            "CheckPlatFlg": "0"
        }
    ]
}

失败:

{
    "status": "error",
    "message": ""
}

4.9 SAP下发 Billing冲销单据查询

请求接口: /api/v1/outBound/getBillingCounteract
接口描述: SAP下发 Billing冲销单据查询
请求类型: HTTP GET

4.9.1 请求参数

字段描述字段名称类型长度必填备注
页数据条目pageSizeINT按分页获取数据,每页显示数据条目,不传参数默认为50条
页数pageNoINT按分页获取数据,当前页码。分页从1开始(1为初始页),不传参数默认是第1页
Billing DocumentbillingNoVARCHAR1504575834
Billing DatebillingYMDdatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
SalesOrder-- SO单号sapOrderNOVARCHAR4300439027
交货单号deliveryNOVARCHAR2200003451
PO日期applyYMDdatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
PO单号applyNOVARCHARRT102002152024140
冲销对应的原单originBillingNOVARCHAR
冲销状态counteractStatusVARCHAR0-已经冲销
1-没找到原单
更新时间updateTimedatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)更新的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss

接口请求示例:
/api/v1/outBound/getBillingCounteract?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49

4.9.2 返回参数

字段描述字段名称类型必填备注
返回状态statusString"success" 表示成功,"error"表示失败
当前页码pageNoINT
每页显示数据条目pageSizeINT
总页数totalPagesINT
总条目数totalRecordsINT
数据dataarray查询出的数据
失败信息messageString当status为error时,会返回message错误信息
data
字段描述字段名称类型必填备注
Billing DocumentBillingNoCHAR
Billing TypeBillingTypeCHAR
销售组织SAP_SALESORGANIZATIONCHAR
分销渠道SAP_DISTRIBUTIONCHANNELCHAR
Billing DateBillingYMDDATETIME
SAP地区代码SAP_REGIONCHAR
公司代码COMPANYCDCHAR
付款方代码SAP_PayerCDCHAR
Sold-ToSAP_SoldToCDCHAR
付款方名称SAP_PayerNMCHAR
城市CITYCHAR
语言SAP_LANGUAGECHAR
付款方地址1LOCATION1CHAR
付款方地址2LOCATION2CHAR
联络号码ContactNumberCHAR
货币SAP_CURRENCYCHAR
行号POSEXCHAR
开票数量BilledQuantityINT
销售单位SalesunitCHAR
净重Netweightnvarchar
物料代码SAPPRODUCTCDCHAR
物料描述ItemDescriptionCHAR
工厂PLANTCHAR
国家CountryCHAR
净值NetValuemoney
税额TaxAmountmoney
产品条形码PRODBARCODE1CHAR
税号TaxCodeCHAR
税率TaxRatemoney
SalesOrder-- SO单号SAPORDERNOCHAR
SO行号POSEX_SOCHAR
交货单号DeliveryNOCHAR
交货单行号COSNRCHAR
会计凭证号AccountingNOCHAR
PO日期APPLYYMDDATETIME
PO单号APPLYNOCHAR
物料确定号MaterialenteredCHAR
含税总金额WHOLEMNYMONEY
Ship-toSAPCUSTOMERCDCHAR
冲销对应的原单OriginBillingNOCHAR
更新担当UPDATEMANchar
更新时间UPDATETIMEdatetime
更新担当CREATEMANchar
更新时间CREATETIMEdatetime
接口运行标志IFFlgchar
对账平台标识CheckPlatFlgchar
产品短码PRODUCTCDchar
冲销状态counteractStatuschar

4.9.3 返回值示例

成功:

{
    "status": "success",
        "pageNo": 1,
        "pageSize": 2,
        "totalPages": 1,
        "totalRecords": 2,
    "data": [
        {
            "BillingNo": "4700310614",
            "BillingType": "Z4S2",
            "SAP_SALESORGANIZATION": "7851",
            "SAP_DISTRIBUTIONCHANNEL": "11",
            "BillingYMD": "2023-04-03T00:00:00",
            "SAP_REGION": "010",
            "COMPANYCD": "785 ",
            "SAP_PayerCD": "2300001897",
            "SAP_SoldToCD": "2100002528",
            "SAP_PayerNM": "北京汉光百货有限责任公司                                                        ",
            "CITY": "北京                                              ",
            "SAP_LANGUAGE": "ZH",
            "LOCATION1": null,
            "LOCATION2": null,
            "ContactNumber": "010-63608899    ",
            "SAP_CURRENCY": null,
            "POSEX": "000020",
            "BilledQuantity": 58240,
            "Salesunit": "EA ",
            "Netweight": "1747200.000",
            "SAPPRODUCTCD": "1018N162000CN     ",
            "ItemDescription": "肌肤之钥 沁肌调理精华露 S 30ml                                                  ",
            "PLANT": "7857",
            "Country": null,
            "NetValue": 0,
            "TaxAmount": 0,
            "PRODBARCODE1": "729238988200      ",
            "TaxCode": null,
            "TaxRate": null,
            "SAPORDERNO": "4300301535",
            "POSEX_SO": "000020",
            "DeliveryNO": "4600263960",
            "COSNR": "000010",
            "AccountingNO": "4700310614",
            "APPLYYMD": "2023-04-03T00:00:00",
            "APPLYNO": "#                                  ",
            "Materialentered": "1018N162000CN                           ",
            "WHOLEMNY": 0,
            "SAPCUSTOMERCD": "2200003433       ",
            "OriginBillingNO": "4700305882     ",
            "UPDATEMAN": "UPDATEMAN           ",
            "UPDATETIME": "2023-07-05T11:19:56.363",
            "CREATEMAN": "SAP                 ",
            "CREATETIME": "2023-04-18T16:00:32.903",
            "IFFlg": "3",
            "CheckPlatFlg": "0",
            "PRODUCTCD": "1018N162  ",
            "counteractStatus": "0"
        },
        {
            "BillingNo": "4700310615",
            "BillingType": "Z4S2",
            "SAP_SALESORGANIZATION": "7851",
            "SAP_DISTRIBUTIONCHANNEL": "11",
            "BillingYMD": "2023-04-16T00:00:00",
            "SAP_REGION": "240",
            "COMPANYCD": "785 ",
            "SAP_PayerCD": "2300001766",
            "SAP_SoldToCD": "2100002670",
            "SAP_PayerNM": "昆明王府井百货有限责任公司                                                      ",
            "CITY": "昆明                                              ",
            "SAP_LANGUAGE": "ZH",
            "LOCATION1": null,
            "LOCATION2": null,
            "ContactNumber": "0871-65230566   ",
            "SAP_CURRENCY": null,
            "POSEX": "000010",
            "BilledQuantity": 7,
            "Salesunit": "EA ",
            "Netweight": null,
            "SAPPRODUCTCD": "74383756801       ",
            "ItemDescription": "SHI 银卡升级礼220206(wtl15ml+utm10ml)                                          ",
            "PLANT": "7857",
            "Country": null,
            "NetValue": 0,
            "TaxAmount": 0,
            "PRODBARCODE1": null,
            "TaxCode": null,
            "TaxRate": null,
            "SAPORDERNO": "4300305736",
            "POSEX_SO": "000010",
            "DeliveryNO": "4600267786",
            "COSNR": "000010",
            "AccountingNO": "4700310615",
            "APPLYYMD": null,
            "APPLYNO": "#                                  ",
            "Materialentered": "74383756801                             ",
            "WHOLEMNY": 0,
            "SAPCUSTOMERCD": "2200003286       ",
            "OriginBillingNO": "4700310183     ",
            "UPDATEMAN": "UPDATEMAN           ",
            "UPDATETIME": "2023-07-05T11:19:56.363",
            "CREATEMAN": "SAP                 ",
            "CREATETIME": "2023-04-18T16:00:33.087",
            "IFFlg": "3",
            "CheckPlatFlg": "0",
            "PRODUCTCD": "74383756  ",
            "counteractStatus": "0"
        }
    ]
}

失败:

{
    "status": "error",
    "message": ""
}

4.10 POS借贷支付方式查询

请求接口: /api/v1/outBound/getCoupoChargePlatform
接口描述: POS借贷支付方式查询
请求类型: HTTP GET

4.10.1 请求参数

字段描述字段名称类型长度必填备注
页数据条目pageSizeINT按分页获取数据,每页显示数据条目,不传参数默认为50条
页数pageNoINT按分页获取数据,当前页码。分页从1开始(1为初始页),不传参数默认是第1页
发生时间 (支付发送时间)tradeTimedatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss
时间戳(当前时间)Timestampdatetime2023-09-15 18:06:32.447,筛选此时间之后(包括此时间)更新的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss

接口请求示例:
/api/v1/outBound/getCoupoChargePlatform?pageNo=1&pageSize=2&Timestamp=2024-07-23 12:02:49

4.10.2 返回参数

字段描述字段名称类型必填备注
返回状态statusString"success" 表示成功,"error"表示失败
当前页码pageNoINT
每页显示数据条目pageSizeINT
总页数totalPagesINT
总条目数totalRecordsINT
数据dataarray查询出的数据
失败信息messageString当status为error时,会返回message错误信息
data
字段描述字段名称类型必填备注
单据唯一标识DocumentIDCHAR
订单类型标志shopCodeVARCHAR10
店铺名称shopNameVARCHAR500
POS机号posNoVARCHAR500固定值:1
终端机号deviceNoVARCHAR500固定值:1
交易号tradeNoVARCHAR500
小票号invoiceNumberVARCHAR500
POS唯一订单号posTradeNoVARCHAR500
销售类型saleTypeVARCHAR500
发生时间 (支付发送时间)tradeTimedatetime500
营业日期 (日结时间)businessDatedate500
支付方式编码payTypeCodeVARCHAR5001:抵扣券(未来不再使用)
15:中信刷卡(未来不再使用)
16:中信支付宝(未来不再使用)
17:中信微信(未来不再使用)
18:中信二维码(未来不再使用)
51:现金
52:二维码支付(POS收银台的二维码)
53:小猫卡
58:扫码支付
59:二维码支付(易生支付收银台的二维码 未来不在使用)
60:电子货币(未来不再使用)
61:移动POS(使用易生收款POS机扫描顾客二维码收款)
63:新天地活动券
64:其他
(POS只允许传红色标记的几种方式)
支付方式名称payTypeNmVARCHAR500
卡类型cardTypeVARCHAR500
金额amountDouble500
内部支付订单号posPayNoVARCHAR500
商户订单号merchantOrderNoVARCHAR500
平台交易号platformTradeNoVARCHAR500
周边标识SysFlgCHAR11-POS
2-SCHD
3-E-order
4-Shopex
5-UCO
6-LeQee
7-决裁
8-采购
时间戳(当前时间)Timestampdatetime同一单的时间戳相同

4.10.3 返回值示例

成功:

{
    "status": "success",
    "pageNo": 1,
    "pageSize": 2,
    "totalPages": 1,
    "totalRecords": 1,
    "data": [
        {
            "DocumentID": "DOC123456",
            "shopCode": "SC001",
            "shopName": "旗舰店",
            "posNo": "1",
            "deviceNo": "1",
            "tradeNo": "TRADE123456",
            "invoiceNumber": "INV123456",
            "posTradeNo": "POSTRADE123456",
            "saleType": "普通销售",
            "tradeTime": "2024-11-26T10:30:00",
            "businessDate": "2024-11-26",
            "payTypeCode": "51",
            "payTypeNm": "现金",
            "cardType": "普通会员卡",
            "amount": 150.75,
            "posPayNo": "PAY123456",
            "merchantOrderNo": "MORD123456",
            "platformTradeNo": "PLTTRADE123456",
            "SysFlg": "1",
            "Timestamp": "2024-11-26T10:30:00"
        }
    ]
}

失败:

{
    "status": "error",
    "message": ""
}

4.11 SAP确认单据查询

请求接口: /api/v1/outBound/getOrderConfirmation
接口描述: SAP确认单据查询
请求类型: HTTP GET

4.11.1 请求参数

字段描述字段名称类型长度必填备注
页数据条目pageSizeINT按分页获取数据,每页显示数据条目,不传参数默认为50条
页数pageNoINT按分页获取数据,当前页码。分页从1开始(1为初始页),不传参数默认是第1页
单据编号applyNoVARCHARRC231000012024A01
SAP Shipto代码sapCustomerCdVARCHAR2200003451
SAP销售订单号sapOrderNoVARCHAR
更新时间updateTimedatetime如2024-10-08 00:00:00.000,筛选此时间之后(包括此时间)的数据,支持yyyy-MM-dd,也可以是yyyy-MM-dd HH:mm:ss

接口请求示例:
/api/v1/outBound/getOrderConfirmation?sapOrderNo=4205171130&pageSize=10&pageNo=1&updateTime=2024-10-31T12:02:23.767

4.11.2 返回参数

字段描述字段名称类型必填备注
返回状态statusString"success" 表示成功,"error"表示失败
当前页码pageNoINT
每页显示数据条目pageSizeINT
总页数totalPagesINT
总条目数totalRecordsINT
数据dataarray查询出的数据
失败信息messageString当status为error时,会返回message错误信息
data
字段描述字段名称类型必填备注
单据编号APPLYNOcharRC-000035-005
Shipto代码SAP_CUSTOMERCDchar2200003675
SAP销售订单号SAPORDERNOchar4205176582
产品代码PRODUCTCDchar34501010
SAP产品代码SAPPRODUCTCDchar34501010102CN
物料确定号DETERMINECODEchar34501010101CN
承认数量ADMQNTYint2
更新时间UPDATETIMEDatetime2024-12-23 12:00:42.720

4.11.3 返回值示例

成功:

{
    "status": "success",
    "pageNo": 1,
    "pageSize": 10,
    "totalPages": 1,
    "totalRecords": 1,
    "data": [
        {
            "APPLYNO": "4205171130                         ",
            "SAP_CUSTOMERCD": "2200004677",
            "SAPORDERNO": "4205171130                         ",
            "PRODUCTCD": "34500509  ",
            "SAPPRODUCTCD": "34500509101CN",
            "DETERMINECODE": "34500509101CN",
            "ADMQNTY": 30,
            "UPDATETIME": "2024-10-31T12:02:23.767"
        }
    ]
}

失败:

{
    "status": "error",
    "message": ""
}

Reviews